'\"macro stdmacro
.\"
.\" Copyright (c) 2020 - 2021 Red Hat.
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
.\" or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.\"
.TH PMDAHACLUSTER 1 "PCP" "Performance Co-Pilot"
.SH NAME
\f3pmdahacluster\f1 \- High Availability Cluster PMDA
.ds ia hacluster
.SH SYNOPSIS
\f3$PCP_PMDAS_DIR/\*(ia/pmda\*(ia\f1
[\f3\-D\f1 \f2debug\f1]
.SH DESCRIPTION
.B pmdahacluster
is capable of collecting metric information to enable the
monitoring of Pacemaker based HA Clusters through Performance Co-Pilot.
.PP
The PMDA collects it's metric data from the following components that
make up a Pacemaker based HA Cluster: Pacemaker, Corosync, SBD, DRBD.
.PP
For more detailed information regarding the metrics available please see
the included pmns and helpfile with the PMDA.
.SH INSTALLATION
Install the HA Cluster PMDA by using the Install script as root:
.sp 1
.RS +4
.ft B
.nf
# cd $PCP_PMDAS_DIR/hacluster
# ./Install
.fi
.ft P
.RE
.sp 1
.PP
To uninstall, do the following as root:
.sp 1
.RS +4
.ft B
.nf
# cd $PCP_PMDAS_DIR/hacluster
# ./Remove
.fi
.ft P
.RE
.sp 1
.PP
.B pmdahacluster
is launched by
.BR pmcd (1)
and should never be executed directly.
The Install and Remove scripts notify
.B pmcd
when the agent is installed or removed.
.SH FILES
.IP "\fB$PCP_PMDAS_DIR/hacluster/help\fR" 4
default help text file for the HA Cluster metrics
.IP "\fB$PCP_PMDAS_DIR/hacluster/Install\fR" 4
installation script for the \fBpmdahacluster\fR agent
.IP "\fB$PCP_PMDAS_DIR/hacluster/Remove\fR" 4
undo installation script for the \fBpmdahacluster\fR agent
.IP "\fB$PCP_LOG_DIR/pmcd/hacluster.log\fR" 4
default log file for error messages from \fBpmdahacluster\fR
.SH PCP ENVIRONMENT
Environment variables with the prefix \fBPCP_\fR are used to parameterize
the file and directory names used by \fBPCP\fR. On each installation, the
file \fB/etc/pcp.conf\fR contains the local values for these variables.
The \fB$PCP_CONF\fR variable may be used to specify an alternative
configuration file, as described in \fIpcp.conf\fR(5).
.SH DEBUGGING OPTIONS
The
.B \-D
or
.B \-\-debug
option enables the output of additional diagnostics on
.I stderr
to help triage problems, although the information is sometimes cryptic and
primarily intended to provide guidance for developers rather end-users.
.I debug
is a comma separated list of debugging options; use
.BR pmdbg (1)
with the
.B \-l
option to obtain
a list of the available debugging options and their meaning.
.SH SEE ALSO
.BR PCPIntro (1),
.BR pmcd (1)
and
.BR pmstore (1).

.\" control lines for scripts/man-spell
.\" +ok+ pmdahacluster hacluster helpfile Corosync DRBD SBD
